home *** CD-ROM | disk | FTP | other *** search
/ Amiga Inside! / Amiga FD Inside (1995)(Ultramax).iso / berndspd / disktools / pvtree / pvtree.doc < prev    next >
Text File  |  1993-11-27  |  7KB  |  256 lines

  1.  
  2.  
  3.        **************************************************************
  4.        *                                                            *
  5.        *  PVTree, PVTreeGUI, PVTreeMUI V1.1 © 1993 by Pascal Pensa  *
  6.        *                                                            *
  7.        *                FreeWare but CopyRight'ed !                 *
  8.        *                                                            *
  9.        **************************************************************
  10.  
  11.  
  12.  
  13. Introduction
  14.  
  15.     PVTree is an utility to see the full (or part) directory tree of any 
  16.     disks devices like HardDisk, Floppy Disk, Ram,... in a graphic window.
  17.  
  18.     It can be used from the Shell or from PVTreeGUI or PVTreeMUI who are
  19.     two GUI designed for PVTree. 
  20.  
  21.     PVTreeGUI use the standard intuition look.
  22.  
  23.     PVTreeMUI use the Magic User Interface from Stefan Stuntz, you must
  24.     have the "muimaster.library" (not provided) in your LIBS: directory 
  25.     to run it. (see ReadMe.MUI)
  26.  
  27.  
  28. General
  29.  
  30.     This utility is provided as is, and you are using PVTree at your
  31.     own risk ! I'm not responsible of any damage that this utility
  32.     could make on your system !
  33.  
  34.     This utility is FreeWare but copyrighted :
  35.  
  36.         - It can't be put in a commecial product witout permission.
  37.  
  38.         - Files names and contain cannot be changed.
  39.  
  40.         - It can be packed.
  41.  
  42.         - It can be put on PD disks, FTP servers and BBS. All these
  43.           files MUST be distributed (normal or packed with lha) :
  44.  
  45.                 - PVTree
  46.                 - PVTree.doc
  47.  
  48.                 - PVTreeGUI
  49.                 - PVTreeGUI.info
  50.  
  51.                 - PVTreeMUI
  52.                 - PVTreeMUI.info
  53.                 - ReadMe.MUI
  54.  
  55.     For bug report, question, suggest, flame and so, contact me.
  56.     (see Author)
  57.  
  58.  
  59. PVTree
  60.  
  61.     Shell only:
  62.  
  63.         PVTree [-options] <root directory>
  64.  
  65.     Options are:
  66.  
  67.         -f          Display all files, default : only dirs
  68.  
  69.         -i          Set info mode on
  70.  
  71.         -w          Force the display in a scrollable window
  72.  
  73.         -d          Force the display to de dynamic
  74.  
  75.         -c          Use only 2 colors
  76.  
  77.         -r <value>  Set the max subdir recusivity, default 10
  78.  
  79.         -s <name>   Set the name of the public screen to use
  80.  
  81.         -S <name>   Like -s but don't use the WB screen if the
  82.                     public screen is not available
  83.  
  84.  
  85.         In the info mode you can click on any file or dir name
  86.         to have some informations on it. When you quit, a global
  87.         information is displayed.
  88.  
  89.         By default PVTree open a fixed window if the tree fits on
  90.         the specified screen, or open a new autoscroll screen if not.
  91.  
  92.         If you specify the -w option, the tree will be always drawn
  93.         in a scrollable window on the specified screen. The window
  94.         use a superbitmap, so the scrolling is fast but take a lot of
  95.         chip memory.
  96.  
  97.         If you specify the -d option (-w is ignored if set) the tree
  98.         is draw in a scrollable window but without superbitmap.
  99.         Only the visible tree is redrawn, so the scrolling is slow 
  100.         but take a few chip memory.
  101.  
  102.         You can use the -c option to keep some chip mem if you don't
  103.         use the -d option.
  104.  
  105.         The -r option stops the root scan if the number of the 
  106.         subdirectory depth is greater than the -r value, including root.
  107.         Limits are 2 to 99 :-) .
  108.  
  109.         PVTree can be made resident. This is useful for floppy users.
  110.  
  111.  
  112. PVTreeGUI
  113.  
  114.         From Shell:
  115.  
  116.             PVTreeGUI [-options] [root directory]
  117.  
  118.  
  119.         Options:
  120.  
  121.             All of PVTree's options and:
  122.  
  123.             -x <value>  Set the left of the GUI window
  124.  
  125.             -y <value>  Set the top of the GUI window
  126.  
  127.  
  128.         From WB:
  129.  
  130.             Supported ToolTypes :
  131.  
  132.             ROOT=name               The default root
  133.  
  134.             FILES=YES/NO            Like -f
  135.  
  136.             INFOMODE=YES/NO         Like -i
  137.  
  138.             FORCEWINDOW=YES/NO      Like -w
  139.  
  140.             DYNAMIC=YES/NO          Like -d
  141.  
  142.             NOCOLOR=YES/NO          Like -c
  143.  
  144.             MAXRECURS=n             Like -r
  145.  
  146.             LEFT=x                  Like -x
  147.             TOP=y                   Like -y
  148.  
  149.             PUBSCREEN=name          Like -s
  150.  
  151.  
  152.         This program is very easy to use:
  153.  
  154.             - Write the root directory name in the string gadget
  155.               or click on the drawer icon to open a requester
  156.  
  157.             - Select options
  158.  
  159.             - Click on GO
  160.  
  161.         Be careful when you click on GO because this program simply
  162.         run the PVTree program in a backgroud process without waiting
  163.         the end of the PVTree's work. This is useful to display 
  164.         different tree at the same time.
  165.  
  166.         PVTree must be in the same directory than PVTreeGUI or in c:
  167.  
  168.  
  169. PVTreeMUI
  170.  
  171.         From Shell:
  172.  
  173.             PVTreeMUI [-options] [root directory]
  174.  
  175.  
  176.         Options:
  177.  
  178.             All of PVTree's options and:
  179.  
  180.             -x <value>  Set the left of the GUI window
  181.  
  182.             -y <value>  Set the top of the GUI window
  183.  
  184.             Note: The -S option is not available.
  185.                   The -s option is simply given to PVTree,
  186.                   use the MUI prefs to set the PVTreeMUI's screen !
  187.  
  188.  
  189.         From WB:
  190.  
  191.             Supported ToolTypes :
  192.  
  193.             ROOT=name               The default root
  194.  
  195.             FILES=YES/NO            Like -f
  196.  
  197.             INFOMODE=YES/NO         Like -i
  198.  
  199.             FORCEWINDOW=YES/NO      Like -w
  200.  
  201.             DYNAMIC=YES/NO          Like -d
  202.  
  203.             NOCOLOR=YES/NO          Like -c
  204.  
  205.             MAXRECURS=n             Like -r
  206.  
  207.             PUBSCREEN=name          Like -s but this option is simply
  208.                                     given to PVTree, use the MUI prefs
  209.                                     to set the PVTreeMUI's screen !
  210.  
  211.  
  212.         This program is very easy to use:
  213.  
  214.             - Write the root directory name in the string gadget
  215.               or click on the drawer icon to open a requester
  216.  
  217.             - Select options
  218.  
  219.             - Click on Draw
  220.  
  221.         PVTree must be in the same directory than PVTreeMUI or in c:
  222.  
  223.         This program uses some MUI enhancements :
  224.  
  225.             - Gadgets can be activated with TAB, RETURN and up/down
  226.               arrow keys
  227.  
  228.             - Iconify gadget
  229.  
  230.             - Appwindow : simply drag a WB icon into the window
  231.               even if it's a file icon and the complete path will
  232.               appears in the string gadget
  233.  
  234.             - Commodity : you can use the Exchange program to
  235.               iconify or quit
  236.  
  237.             - Look configuration with the MUI prefs tool (not
  238.               provided)
  239.  
  240.  
  241. Author
  242.  
  243.         Pascal Pensa
  244.  
  245.         11, Avenue Joliette
  246.         06100 NICE
  247.  
  248.         FRANCE
  249.  
  250.  
  251.         Internet : pensa@taloa.unice.fr
  252.  
  253.  
  254.         Have fun, and please excuse me for my very bad English :-(
  255.  
  256.